/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Nov 11, 2023 (Adrian Nembach, KNIME GmbH, Konstanz, Germany): created
 */
package org.knime.core.node.func;

import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.knime.core.node.InvalidSettingsException;

/**
 *
 * @author Adrian Nembach, KNIME GmbH, Konstanz, Germany
 * @param <E> The type of enum this EnumArgumentType wraps
 * @since 5.2
 */
public interface EnumArgumentType<E extends Enum<E>> extends ArgumentType {

    /**
     * @return the class of the enum type
     */
    Class<E> getEnumClass();

    /**
     * @param <E> the type of enum
     * @param enumClass the class of the enum
     * @return an EnumArgumentType representing the enumClass
     */
    static <E extends Enum<E>> EnumArgumentType<E> create(final Class<E> enumClass) {
        return new DefaultEnumArgumentType<>(enumClass);
    }

    /**
     * @param <E> the type of enum
     * @param enumClass the class of the enum
     * @return string representing the constants of this class in the format [constant1, constant2]
     */
    static<E extends Enum<E>> String createValuesString(final Class<E> enumClass) {
        return Stream.of(enumClass.getEnumConstants())//
                .map(Enum::name)//
                .collect(Collectors.joining(", ", "[", "]"));
    }

    /**
     * @param <E> the enum class
     * @param enumClass the enum class
     * @param name of the constant
     * @return the enum constant
     * @throws InvalidSettingsException if the given name is not a valid constant of the enum
     */
    static <E extends Enum<E>> E getConstant(final Class<E> enumClass, final String name)
        throws InvalidSettingsException {
        try {
            return Enum.valueOf(enumClass, name);
        } catch (IllegalArgumentException ex) {
            throw new InvalidSettingsException(ex.getMessage(), ex);
        }
    }

}
